yCheckbox

Description

The yCheckbox is an essential user interface element that allows users to make binary choices or toggle between two states. It's commonly used in forms, settings, and wherever a selection is needed. Usecases can be:

• disabling features or other components
• requesting consent for terms and conditions
• adjusting settings for an app

Basic Structure

The basic structure of yCheckbox includes a checkbox icon and an optional label that describes its purpose.

@note Image

Label

The label is an optional text placed next to the checkbox, providing information about the choice it represents. It can be positioned on either side of the checkbox, depending on the layout requirements.

Box

The box represents the clickable area of the yCheckbox, showing an indicator when selected. It can be customized in terms of color, size, and border to match the application's design theme.

Properties

Through its various properties the yCheckbox can be configured to suit your needs. The display below provides you with an overview of all the yCheckbox properties.

Properties can be changed directly through three methods:

• Inside the Toolbar, which is positioned in your workarea next to your component where you need it. It shows the most important properties, thus providing a fast and efficient way to configure your component in the most basic way.
• It may also occur in the Toolbar Extension, which is a seamless extension accesible as a dropdown item of the Toolbar. It extends the functionality of the Toolbar by providing advanced pickers for most used properties.
• Inside the Detail Panel, which is located in the righthand drawer. Every property of a component can be configured here.

Generic

METAread more

Name: componentId

Not Editable

Number Property

--y-checkbox__component-id

The identifier of the component that is unique within a page.

Name: componentType

Not Editable

String Property

--y-checkbox__component-type

The type of the component. For this component it is -checkbox.

Name: name

String Property

--y-checkbox__name

The custom name of the component. It serves for better identification of the component.

Name: version

String Property

--y-checkbox__version

The custom version of the Checkbox-component. This can be used to ensure that all components work well together.

Name: coreTheme

String Property

--y-checkbox__core-theme

The CoreTheme, which will be apllied to the Checkbox. For further information on themes visit the themes page.

Name: subTheme

String Property

--y-checkbox__sub-theme

The subtheme subordinated to the previously specified CoreTheme, which will be apllied to the Checkbox. For further information on themes visit the themes page.

Name: groupTheme

String Property

--y-checkbox__group-theme

The group theme is a further variation of the subtheme which is specified especially for variations of a component inside the subtheme. For further information on themes visit the Theme-Manager page.

DISPLAYread more

Name: display

String Property

--y-checkbox__display

This property specifies the display behavior of the component. This can be be set to:

• none
• block
• flex
• inline

Name: position

Not Editable

String Property

--y-checkbox__position

This property specifies the type of positioning method used for the component. This can be be set to:

• static
• relative
• absolute
• sticky
• fixed

Name: visible

String Property

--y-checkbox__visible

This property can toggle the visibility of the component. The two modes are completely hidden and fully shown.

SIZEread more

Name: minWidth

Injectable

UnitNumber Property

--y-checkbox__min-width

The minimum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: minHeight

Injectable

UnitNumber Property

--y-checkbox__min-height

The minimum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: width

Injectable

UnitNumber Property

--y-checkbox__width

The value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: height

Injectable

UnitNumber Property

--y-checkbox__height

The value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: maxWidth

Injectable

UnitNumber Property

--y-checkbox__max-width

The maximum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: maxHeight

Injectable

UnitNumber Property

--y-checkbox__max-height

The maximum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: flex

String Property

--y-checkbox__flex

The flex property sets the length on flexible items. This sets the value in n-fold shares extrapolated to all other components with the flex display within the same container.

PLACEMENTread more

Name: marginTop

Injectable

UnitNumber Property

--y-checkbox__margin-top

This property creates a space around the component, outside of the top border. This can be set in percent or pixels.

Name: marginRight

Injectable

UnitNumber Property

--y-checkbox__margin-right

This property creates a space around the component, outside of the right border. This can be set in percent or pixels.

Name: marginBottom

Injectable

UnitNumber Property

--y-checkbox__margin-bottom

This property creates a space around the component, outside of the bottom border. This can be set in percent or pixels.

Name: marginLeft

Injectable

UnitNumber Property

--y-checkbox__margin-left

This property creates a space around the component, outside of the left border. This can be set in percent or pixels.

Name: paddingTop

Injectable

UnitNumber Property

--y-checkbox__padding-top

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Name: paddingRight

Injectable

UnitNumber Property

--y-checkbox__padding-right

This property creates a space within the component, inside of the right border. This can be set in percent or pixels.

Name: paddingBottom

Injectable

UnitNumber Property

--y-checkbox__padding-bottom

This property creates a space within the component, inside of the bottom border. This can be set in percent or pixels.

Name: paddingLeft

Injectable

UnitNumber Property

--y-checkbox__padding-left

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Style

BACKGROUNDread more

Name: bgColor

Injectable

Color Property

--y-checkbox__bg-color

--y-checkbox__bg-color__normal

--y-checkbox__bg-color__hover

--y-checkbox__bg-color__focus

--y-checkbox__bg-color__active

--y-checkbox__bg-color__disabled

--y-checkbox__bg-color__error

The color of the background. This can be set as a color from a palette or a custom hex color.

BORDERread more

Name: borderTopColor

Injectable

Color Property

--y-checkbox__border-top-color

--y-checkbox__border-top-color__normal

--y-checkbox__border-top-color__hover

--y-checkbox__border-top-color__focus

--y-checkbox__border-top-color__active

--y-checkbox__border-top-color__disabled

--y-checkbox__border-top-color__error

The color of the top border. This can be set as a color from a palette or a custom hex color.

Name: borderTopStyle

Injectable

String Property

--y-checkbox__border-top-style

--y-checkbox__border-top-style__normal

--y-checkbox__border-top-style__hover

--y-checkbox__border-top-style__focus

--y-checkbox__border-top-style__active

--y-checkbox__border-top-style__disabled

--y-checkbox__border-top-style__error

The style of the top border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderTopWidth

Injectable

UnitNumber Property

--y-checkbox__border-top-width

--y-checkbox__border-top-width__normal

--y-checkbox__border-top-width__hover

--y-checkbox__border-top-width__focus

--y-checkbox__border-top-width__active

--y-checkbox__border-top-width__disabled

--y-checkbox__border-top-width__error

The width of the top border. This can be set in percent or pixels.

Name: borderRightColor

Injectable

Color Property

--y-checkbox__border-right-color

--y-checkbox__border-right-color__normal

--y-checkbox__border-right-color__hover

--y-checkbox__border-right-color__focus

--y-checkbox__border-right-color__active

--y-checkbox__border-right-color__disabled

--y-checkbox__border-right-color__error

The color of the right border. This can be set as a color from a palette or a custom hex color.

Name: borderRightStyle

Injectable

String Property

--y-checkbox__border-right-style

--y-checkbox__border-right-style__normal

--y-checkbox__border-right-style__hover

--y-checkbox__border-right-style__focus

--y-checkbox__border-right-style__active

--y-checkbox__border-right-style__disabled

--y-checkbox__border-right-style__error

The style of the right border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderRightWidth

Injectable

UnitNumber Property

--y-checkbox__border-right-width

--y-checkbox__border-right-width__normal

--y-checkbox__border-right-width__hover

--y-checkbox__border-right-width__focus

--y-checkbox__border-right-width__active

--y-checkbox__border-right-width__disabled

--y-checkbox__border-right-width__error

The width of the right border. This can be set in percent or pixels.

Name: borderBottomColor

Injectable

Color Property

--y-checkbox__border-bottom-color

--y-checkbox__border-bottom-color__normal

--y-checkbox__border-bottom-color__hover

--y-checkbox__border-bottom-color__focus

--y-checkbox__border-bottom-color__active

--y-checkbox__border-bottom-color__disabled

--y-checkbox__border-bottom-color__error

The color of the bottom border. This can be set as a color from a palette or a custom hex color.

Name: borderBottomStyle

Injectable

String Property

--y-checkbox__border-bottom-style

--y-checkbox__border-bottom-style__normal

--y-checkbox__border-bottom-style__hover

--y-checkbox__border-bottom-style__focus

--y-checkbox__border-bottom-style__active

--y-checkbox__border-bottom-style__disabled

--y-checkbox__border-bottom-style__error

The style of the bottom border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderBottomWidth

Injectable

UnitNumber Property

--y-checkbox__border-bottom-width

--y-checkbox__border-bottom-width__normal

--y-checkbox__border-bottom-width__hover

--y-checkbox__border-bottom-width__focus

--y-checkbox__border-bottom-width__active

--y-checkbox__border-bottom-width__disabled

--y-checkbox__border-bottom-width__error

The width of the bottom border. This can be set in percent or pixels.

Name: borderLeftColor

Injectable

Color Property

--y-checkbox__border-left-color

--y-checkbox__border-left-color__normal

--y-checkbox__border-left-color__hover

--y-checkbox__border-left-color__focus

--y-checkbox__border-left-color__active

--y-checkbox__border-left-color__disabled

--y-checkbox__border-left-color__error

The color of the left border. This can be set as a color from a palette or a custom hex color.

Name: borderLeftStyle

Injectable

String Property

--y-checkbox__border-left-style

--y-checkbox__border-left-style__normal

--y-checkbox__border-left-style__hover

--y-checkbox__border-left-style__focus

--y-checkbox__border-left-style__active

--y-checkbox__border-left-style__disabled

--y-checkbox__border-left-style__error

The style of the left border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderLeftWidth

Injectable

UnitNumber Property

--y-checkbox__border-left-width

--y-checkbox__border-left-width__normal

--y-checkbox__border-left-width__hover

--y-checkbox__border-left-width__focus

--y-checkbox__border-left-width__active

--y-checkbox__border-left-width__disabled

--y-checkbox__border-left-width__error

The width of the left border. This can be set in percent or pixels.

Name: borderRadius

Injectable

UnitNumber Property

--y-checkbox__border-radius

The radius of the corners of all the borders. This can be set in percent or pixels.

SHADOWread more

Name: boxShadow

Injectable

String Property

--y-checkbox__box-shadow

--y-checkbox__box-shadow__normal

--y-checkbox__box-shadow__hover

--y-checkbox__box-shadow__focus

--y-checkbox__box-shadow__active

--y-checkbox__box-shadow__disabled

--y-checkbox__box-shadow__error

The shadow of the component. This is set by the 4 sub-properties x, y, blur and spread of the shadow-property, which can be further read about in the shadow-property section.

OPACITYread more

Name: opacity

Injectable

Number Property

--y-checkbox__opacity

--y-checkbox__opacity__normal

--y-checkbox__opacity__hover

--y-checkbox__opacity__focus

--y-checkbox__opacity__active

--y-checkbox__opacity__disabled

--y-checkbox__opacity__error

The opacity of all colored parts of the component. This value is set in percent.

LABELread more

Name: label__fontColor

Injectable

Color Property

--y-checkbox__label__font-color

--y-checkbox__label__font-color__normal

--y-checkbox__label__font-color__hover

--y-checkbox__label__font-color__focus

--y-checkbox__label__font-color__active

--y-checkbox__label__font-color__disabled

--y-checkbox__label__font-color__error

The color of the label text. This can be set as a color from a palette or a custom hex color.

Name: label__fontFamily

Injectable

String Property

--y-checkbox__label__font-family

--y-checkbox__label__font-family__normal

--y-checkbox__label__font-family__hover

--y-checkbox__label__font-family__focus

--y-checkbox__label__font-family__active

--y-checkbox__label__font-family__disabled

--y-checkbox__label__font-family__error

The font-family of the label text. This can be picked from a large list of provided fonts.

Name: label__fontWeight

Injectable

Number Property

--y-checkbox__label__font-weight

--y-checkbox__label__font-weight__normal

--y-checkbox__label__font-weight__hover

--y-checkbox__label__font-weight__focus

--y-checkbox__label__font-weight__active

--y-checkbox__label__font-weight__disabled

--y-checkbox__label__font-weight__error

The font-weight of the label text. This can be set in a custom number, as example:

• 400 = normal(regular)
• 500 = medium
• 600 = semi bold
• 700 = bold

Name: label__fontStyle

Injectable

String Property

--y-checkbox__label__font-style

--y-checkbox__label__font-style__normal

--y-checkbox__label__font-style__hover

--y-checkbox__label__font-style__focus

--y-checkbox__label__font-style__active

--y-checkbox__label__font-style__disabled

--y-checkbox__label__font-style__error

The font-style of the label text. This can be set to normal, italic or oblique.

Name: label__textTransform

Injectable

String Property

--y-checkbox__label__text-transform

--y-checkbox__label__text-transform__normal

--y-checkbox__label__text-transform__hover

--y-checkbox__label__text-transform__focus

--y-checkbox__label__text-transform__active

--y-checkbox__label__text-transform__disabled

--y-checkbox__label__text-transform__error

The text-transformation of the label text. This can be set to:

• capitalize
• uppercase
• lowercase
• none
• full-width

Name: label__textDecoration

Injectable

String Property

--y-checkbox__label__text-decoration

--y-checkbox__label__text-decoration__normal

--y-checkbox__label__text-decoration__hover

--y-checkbox__label__text-decoration__focus

--y-checkbox__label__text-decoration__active

--y-checkbox__label__text-decoration__disabled

--y-checkbox__label__text-decoration__error

The text-decoration of the label text. This can be set to:

• strikethrough
• underline

Name: label__fontSize

Injectable

UnitNumber Property

--y-checkbox__label__font-size

The font-size of the label text. This can be set in: -cm

• mm
• in
• px
• em
• ex
• ch
• rem

Name: label

String Property

--y-checkbox__label

The actual written text in the label. There is no limit to the number of characters.

Name: leftLabel

String Property

--y-checkbox__left-label

The actual written text in the left label. There is no limit to the number of characters.

BOXread more

Name: boxOff__bgColor

Injectable

Color Property

--y-checkbox__box-off__bg-color

--y-checkbox__box-off__bg-color__normal

--y-checkbox__box-off__bg-color__hover

--y-checkbox__box-off__bg-color__focus

--y-checkbox__box-off__bg-color__active

--y-checkbox__box-off__bg-color__disabled

--y-checkbox__box-off__bg-color__error

The color of the turned off box background. This can be set as a color from a palette or a custom hex color.

Name: boxOff__borderColor

Injectable

Color Property

--y-checkbox__box-off__border-color

--y-checkbox__box-off__border-color__normal

--y-checkbox__box-off__border-color__hover

--y-checkbox__box-off__border-color__focus

--y-checkbox__box-off__border-color__active

--y-checkbox__box-off__border-color__disabled

--y-checkbox__box-off__border-color__error

The color of the border of the turned off box. This can be set as a color from a palette or a custom hex color.

Name: boxOn__bgColor

Injectable

Color Property

--y-checkbox__box-on__bg-color

--y-checkbox__box-on__bg-color__normal

--y-checkbox__box-on__bg-color__hover

--y-checkbox__box-on__bg-color__focus

--y-checkbox__box-on__bg-color__active

--y-checkbox__box-on__bg-color__disabled

--y-checkbox__box-on__bg-color__error

The color of the turned on box background. This can be set as a color from a palette or a custom hex color.

Name: boxOn__borderColor

Injectable

Color Property

--y-checkbox__box-on__border-color

--y-checkbox__box-on__border-color__normal

--y-checkbox__box-on__border-color__hover

--y-checkbox__box-on__border-color__focus

--y-checkbox__box-on__border-color__active

--y-checkbox__box-on__border-color__disabled

--y-checkbox__box-on__border-color__error

The color of the border of the turned on box. This can be set as a color from a palette or a custom hex color.

Name: boxOn__iconColor

Injectable

Color Property

--y-checkbox__box-on__icon-color

--y-checkbox__box-on__icon-color__normal

--y-checkbox__box-on__icon-color__hover

--y-checkbox__box-on__icon-color__focus

--y-checkbox__box-on__icon-color__active

--y-checkbox__box-on__icon-color__disabled

--y-checkbox__box-on__icon-color__error

The color of the icon inside the turned on box. This can be set as a color from a palette or a custom hex color.

Name: box__borderWidth

Injectable

UnitNumber Property

--y-checkbox__box__border-width

The value for the width of the border of box. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: box__borderStyle

Injectable

String Property

--y-checkbox__box__border-style

The style of the border of the box. This can be be set to:

• solid
• dotted
• dashed
• none

Name: box__circleAnimationColor

Injectable

Color Property

--y-checkbox__box__circle-animation-color

--y-checkbox__box__circle-animation-color__hover

--y-checkbox__box__circle-animation-color__focus

--y-checkbox__box__circle-animation-color__active

--y-checkbox__box__circle-animation-color__error

The color of the circle-animation of the box. This can be set as a color from a palette or a custom hex color.

Name: box__circleAnimationColorOpacity

Injectable

Number Property

--y-checkbox__box__circle-animation-color-opacity

--y-checkbox__box__circle-animation-color-opacity__hover

--y-checkbox__box__circle-animation-color-opacity__focus

--y-checkbox__box__circle-animation-color-opacity__active

--y-checkbox__box__circle-animation-color-opacity__error

The opacity of the colored circle animation of the box. This value is set in percent.

Name: box__circleAnimationSize

Injectable

Number Property

--y-checkbox__box__circle-animation-size

The size of the circle animation of the box. This value is set in px.

Name: value

Boolean Property

--y-checkbox__value

The value to be displayed inside the box.

Checkbox

STATEread more

Name: disabled

Boolean Property

--y-checkbox__disabled

This property can disable or enable the disabled-state of the Checkbox-component.

Name: error

Boolean Property

--y-checkbox__error

This property can disable or enable the error-state of the Checkbox-component.

TOOLTIPread more

Name: tooltip

String Property

--y-checkbox__tooltip

The text of the tooltip, which is displayed when hovering over the Checkbox-component. If you do not insert anything, no tooltip appears.

ERRORread more

Name: errorMessage

String Property

--y-checkbox__error-message

The message to be displayed, if an error occurs.

Links

VALUEread more

Name: sourceLinkValue

String Property

--y-checkbox__source-link-value

This property defines a link to another component by specifying the componentId or componentName, Page, Component, ID, Event. The data from the link will represent true or false.

Events

LIFECYCLEread more

Name: EvtInit

String Property

--y-checkbox__-evt-init

This specifies the function to be called, when the Checkbox is initialized.

INPUTread more

Name: EvtClicked

String Property

--y-checkbox__-evt-clicked

The event that is triggered when clicking inside the input field.

Usage

In this section you'll find a collection of application scenarios and examples that illustrate how to leverage the yCheckbox in ways that deviate from its standard behavior, as defined by yBase. This section aims to inspire and guide you through various possibilities, helping you to implement more complex or unique functionalities tailored to your specific needs. General properties that are universally applicable can be found in the yBase usage section.

Variations

Elevated

genericarrow_forward_iossizearrow_forward_iosminWidth95px

genericarrow_forward_iossizearrow_forward_iosmaxHeight30px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosshadowarrow_forward_iosboxShadow__normal0 3px 6px 0 rgba(16, 18, 24, 0.2)

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOff__bgColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOff__borderColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__bgColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__borderColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__iconColor#44ddbb

Flat

genericarrow_forward_iossizearrow_forward_iosminWidth95px

genericarrow_forward_iossizearrow_forward_iosmaxHeight30px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOff__bgColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOff__borderColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__bgColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__borderColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__iconColor#44ddbb

Outlined

genericarrow_forward_iossizearrow_forward_iosminWidth95px

genericarrow_forward_iossizearrow_forward_iosmaxHeight30px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normaltransparent

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderStyleTop__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleRight__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleBottom__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderStyleLeft__normalsolid

stylearrow_forward_iosborderarrow_forward_iosborderWidthTop__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthRight__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthBottom__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderWidthLeft__normal2px

stylearrow_forward_iosborderarrow_forward_iosborderColorTop__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorRight__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorBottom__normal#44ddbb

stylearrow_forward_iosborderarrow_forward_iosborderColorLeft__normal#44ddbb

stylearrow_forward_iosboxarrow_forward_iosboxOff__bgColortransparent

stylearrow_forward_iosboxarrow_forward_iosboxOff__borderColor#44ddbb

stylearrow_forward_iosboxarrow_forward_iosboxOn__bgColortransparent

stylearrow_forward_iosboxarrow_forward_iosboxOn__borderColor#44ddbb

stylearrow_forward_iosboxarrow_forward_iosboxOn__iconColor#44ddbb

Rounded

genericarrow_forward_iossizearrow_forward_iosminWidth95px

genericarrow_forward_iossizearrow_forward_iosmaxHeight30px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normal#44ddbb

stylearrow_forward_iosshadowarrow_forward_iosboxShadow__normal0 3px 6px 0 rgba(16, 18, 24, 0.2)

stylearrow_forward_iosborderarrow_forward_iosborderRadius20px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOff__bgColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOff__borderColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__bgColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__borderColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__iconColor#44ddbb

Plain

genericarrow_forward_iossizearrow_forward_iosminWidth95px

genericarrow_forward_iossizearrow_forward_iosmaxHeight30px

stylearrow_forward_iosbackgroundarrow_forward_iosbgColor__normaltransparent

stylearrow_forward_iosborderarrow_forward_iosborderRadius8px

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor__normal#44ddbb

stylearrow_forward_iosboxarrow_forward_iosboxOff__bgColortransparent

stylearrow_forward_iosboxarrow_forward_iosboxOff__borderColor#44ddbb

stylearrow_forward_iosboxarrow_forward_iosboxOn__bgColortransparent

stylearrow_forward_iosboxarrow_forward_iosboxOn__borderColor#44ddbb

stylearrow_forward_iosboxarrow_forward_iosboxOn__iconColor#44ddbb

Custom Style Variations

Configure your yCheckbox with unique styles to emphasize their importance or to better integrate with your application's design.

Standard

genericarrow_forward_iossizearrow_forward_iosminWidth200px

stylearrow_forward_iosboxarrow_forward_iosboxOff__bgColor#FFFFFF

stylearrow_forward_iosboxarrow_forward_iosboxOff__borderColor#767676

stylearrow_forward_iosboxarrow_forward_iosboxOn__bgColor#4A90E2

stylearrow_forward_iosboxarrow_forward_iosboxOn__borderColor#4A90E2

stylearrow_forward_iosboxarrow_forward_iosboxOn__iconColor#FFFFFF

stylearrow_forward_ioslabelarrow_forward_ioslabel__fontColor#333333

stylearrow_forward_ioslabelarrow_forward_ioslabel'Standard Checkbox'

Dark Mode

genericarrow_forward_iossizearrow_forward_iosminWidth200px

stylearrow_forward_iosboxarrow_forward_iosboxOff__bgColor#333333

stylearrow_forward_iosboxarrow_forward_iosboxOff__borderColor#AAAAAA

stylearrow_forward_iosboxarrow_forward_iosboxOn__bgColor#007AFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__borderColor#007AFF

stylearrow_forward_iosboxarrow_forward_iosboxOn__iconColor#FFFFFF

stylearrow_forward_ioslabelarrow_forward_iosfontColor#333333

stylearrow_forward_ioslabelarrow_forward_ioslabel'Dark Mode Checkbox'

Setting the Checkbox Value

The yCheckbox component's value can be dynamically assigned either programmatically via JavaScript or by establishing a link to another component's value—known as a SourceLink. This flexibility allows the yCheckbox to respond to user interactions or application states in real time.

Via JavaScript

To set the yCheckbox's value using JavaScript, access the value property within the "style" > "thumb" category. This method is ideal for changing the yCheckbox's state based on user interactions or other events within your application.

Here’s how you can set the value in JavaScript:

EvtClicked

// function onCheckbox_1_EvtClicked (apiObject, component, eventData) {
var desiredValue = true; // or false
component.set("style", "thumb", "value", desiredValue);
// }

Simply replace desiredValue with the appropriate boolean or comparable value that corresponds to the yCheckbox's position.

Via SourceLink Picker

To link the yCheckbox’s value with another component (e.g. another yCheckbox), use the SourceLink Picker. This feature binds the yCheckbox’s state to another component's value, allowing for integrated component behavior.

How to:

1. Create another yCheckbox component in your application.
2. Select the created yCheckbox and open the Detail Panel.
3. Within these settings, proceed to the "Links" section and open "value".
4. Create a new SourceLink -> select the other yCheckbox you just created and choose "value" as an event.

Now each time you trigger the second yCheckbox, the first one will also be triggered. To make this both ways you have to repeat this process for the other yCheckbox as well.

Alternatively you can use the SourceLink Picker in the Toolbar as a Toolbar Extension.

Setting Error States

Use the yCheckbox to provide immediate feedback on form validations by setting an error state.

yButton:EvtChanged

// Example: Validate Checkbox State
// function onButton_1_EvtClicked (apiObject, component, eventData) {

leet checkboxComponent = apiObject.ui.getObject(checkboxId);
const isChecked =  checkboxComponent.get("style", "box", "value");

if (!isChecked) {
  // Set error state and message
  checkboxComponent.set("component", "error", "error", true);
  checkboxComponent.set("component", "error", "errorMessage", "This field is required.");
} else {
  // Clear error state
  checkboxComponent.set("component", "error", "error", false);
}
//}

Integration with Other Components

The yCheckbox can interact with other components, enabling or disabling functionalities based on its state. This behavior is essential for creating dynamic forms and interfaces.

Checkbox EvtClicked

// Example: Toggle visibility of another component based on checkbox state
// function onCheckbox_1_EvtClicked (apiObject, component, eventData) {

const isChecked = eventData.data;
let targetComponentId = 2;
let targetComponentType = "y-input";

const targetComponent = apiObject.ui.getObject(
  targetComponentId,
  targetComponentType
);

if (isChecked) {
  targetComponent.set("generic", "display", "visible", "visible");
} else {
  targetComponent.set("generic", "display", "visible", "hidden");
}

//}